<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * The mod_refworks course module viewed event.
 *
 * @package    mod_refworks
 * @copyright  2014 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace mod_refworks\event;

defined('MOODLE_INTERNAL') || die();

/**
 * The mod_refworks course module viewed event class.
 *
 * @package    mod_refworks
 * @since      Moodle 2.7
 * @copyright  2014 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class course_module_viewed extends \core\event\course_module_viewed {

    /**
     * Init method.
     *
     * @return void
     */
    protected function init() {
        global $COURSE, $SITE;
        $this->data['crud'] = 'r';
        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
        if ($COURSE->id != $SITE->id) {
            // Hack to work out if we are in an instance.
            $this->data['objecttable'] = 'refworks';
        }
    }

    /**
     * Returns description of what happened.
     *
     * @return string
     */
    public function get_description() {
        if ($this->contextlevel == CONTEXT_SYSTEM) {
            return "The user with id '$this->userid' viewed the refworks activity module directly. {$this->other['info']}";
        } else {
            return parent::get_description() . ' Action: ' . $this->other['info'];
        }
    }

    /**
     * Get URL related to the action.
     *
     * @return \moodle_url
     */
    public function get_url() {
        return new \moodle_url('/mod/refworks/' . $this->other['logurl']);
    }

    /**
     * Return the legacy event log data.
     *
     * @return array|null
     */
    protected function get_legacy_logdata() {
        global $SITE;
        return array($this->courseid ? $this->courseid : $SITE->id, 'refworks', 'view', $this->other['logurl'],
                $this->other['info'], $this->contextinstanceid);
    }

    /**
     * Custom validation.
     *
     * @throws \coding_exception
     * @return void
     */
    protected function validate_data() {
        // Note don't call parent validation as we make this work at system level also.
        // Make sure this class is never used without proper object details.
        if ($this->contextlevel == CONTEXT_MODULE &&
                (empty($this->objectid) || empty($this->objecttable))) {
            throw new \coding_exception('The course_module_viewed event must define objectid and object table.');
        }
        // Make sure this class is never used without url details.
        if (empty($this->other['logurl'])) {
            throw new \coding_exception('logurl must be set in other.');
        }

        // Make sure this class is never used without info details.
        if (!isset($this->other['info'])) {
            throw new \coding_exception('info must be set in other.');
        }
    }
}
